Class UserTrafficImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.UserTrafficImpl
All Implemented Interfaces:
IPCObject, UserTraffic

public class UserTrafficImpl extends IPCObjectImpl implements UserTraffic
Information provided by the PKI file:

    \class UserTraffic
    
    \brief UserTraffic represents the user traffic information (PDU).
    
    \example appWindow().getActiveFile().getMainSimulation().getFrameInstanceAt(0).getTrafficSource()
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • getTrafficColorCode

      public int getTrafficColorCode()
      Information provided by the PKI file:
      
          \brief Returns the color code of this PDU.
          
          \return int, the color code of this PDU.
          
              
      Specified by:
      getTrafficColorCode in interface UserTraffic
      Returns:
      int Returns a int
    • getTrafficTypeString

      public String getTrafficTypeString()
      Information provided by the PKI file:
      
          \brief Returns the traffic type of this PDU.
          
          \return QString, the traffic type of this PDU.
          
              
      Specified by:
      getTrafficTypeString in interface UserTraffic
      Returns:
      String Returns a String
    • getSourceDevice

      public Device getSourceDevice()
      Information provided by the PKI file:
      
          \brief Returns the source device of this PDU.
          
          \return Device, the Device object of the source device of this PDU.
          
              
      Specified by:
      getSourceDevice in interface UserTraffic
      Returns:
      Device Returns a Device
    • getDestinationDevice

      public Device getDestinationDevice()
      Information provided by the PKI file:
      
          \brief Returns the destination device of this PDU.
          
          \return Device, the Device object of the destination device of this PDU.
          
              
      Specified by:
      getDestinationDevice in interface UserTraffic
      Returns:
      Device Returns a Device
    • getPdu

      public Pdu getPdu()
      Information provided by the PKI file:
      
          \brief Returns the PDU object of this PDU.
          
          \return PDU, the PDU object of this PDU.
          
              
      Specified by:
      getPdu in interface UserTraffic
      Returns:
      Pdu Returns a Pdu
    • getSendPort

      public Port getSendPort()
      Information provided by the PKI file:
      
          \brief Returns the sending port of this PDU.
          
          \return Port, the Port object of the sending port of this PDU.
          
              
      Specified by:
      getSendPort in interface UserTraffic
      Returns:
      Port Returns a Port
    • getCanonicalSource

      public String getCanonicalSource()
      Information provided by the PKI file:
      
          \brief Returns the name of the source of this PDU.
          
          \return QString, the name of the source of this PDU.
          
              
      Specified by:
      getCanonicalSource in interface UserTraffic
      Returns:
      String Returns a String
    • getCanonicalDestination

      public String getCanonicalDestination()
      Information provided by the PKI file:
      
          \brief Returns the name of the destination of this PDU.
          
          \return QString, the name of the destination of this PDU.
          
              
      Specified by:
      getCanonicalDestination in interface UserTraffic
      Returns:
      String Returns a String
    • getStatus

      public TrafficStatus getStatus()
      Information provided by the PKI file:
      
          \brief Returns the status of this PDU.
          
          \return TrafficStatus,      the status of this PDU.
          Traffic statuses:   eTrafficNotSend = 0,
          eTrafficInProgress = 1,
          eTrafficFailed = 2,
          eTrafficSuccessful = 3
          
              
      Specified by:
      getStatus in interface UserTraffic
      Returns:
      TrafficStatus Returns a TrafficStatus
    • getTestCondition

      public TrafficStatus getTestCondition()
      Information provided by the PKI file:
      
          \brief Returns the connectivity test status of this PDU.
          
          \return TrafficStatus,      the the test condition status of this PDU.
          Traffic statuses:   eTrafficNotSend = 0,
          eTrafficInProgress = 1,
          eTrafficFailed = 2,
          eTrafficSuccessful = 3
          
              
      Specified by:
      getTestCondition in interface UserTraffic
      Returns:
      TrafficStatus Returns a TrafficStatus
    • getPoints

      public int getPoints()
      Information provided by the PKI file:
      
          \brief Returns the point value of this PDU.
          
          \return int, the point value of this PDU.
          
              
      Specified by:
      getPoints in interface UserTraffic
      Returns:
      int Returns a int
    • getPduSize

      public int getPduSize()
      Information provided by the PKI file:
      
          \brief Returns the size of this PDU.
          
          \return int, the size of this PDU.
          
              
      Specified by:
      getPduSize in interface UserTraffic
      Returns:
      int Returns a int